docs: fix broken documentation links#156
Conversation
github-actions
Bot
added
size:M
|
Caution Review failedPull request was closed or merged during review WalkthroughThis PR updates internal documentation paths and navigation to new top-level routes (about-nemo-relay, supported-integrations, integrate-into-frameworks, observability-plugin, adaptive-plugin), adjusts many cross-references across docs, and fixes slugified output path construction in the Rust reference generator script. ChangesDocumentation Path Restructuring
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/resources/troubleshooting/index.mdx`:
- Line 185: Replace the stale anchor text "Integrate Frameworks" with the
canonical "Integrate into Frameworks" in the link trio (the links that point to
/integrate-into-frameworks/about, /integrate-into-frameworks/wrap-tool-calls,
/integrate-into-frameworks/wrap-llm-calls) so the link text matches the renamed
public surface; keep the existing URLs unchanged and only update the visible
text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 74ebbf6b-f332-402a-abea-e9f002f09e9a
📒 Files selected for processing (56)
CONTRIBUTING.mddocs/about-nemo-relay/architecture.mdxdocs/about-nemo-relay/concepts/events.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/about-nemo-relay/concepts/index.mdxdocs/about-nemo-relay/concepts/middleware.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/about-nemo-relay/concepts/scopes.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/about-nemo-relay/release-notes/related-topics.mdxdocs/adaptive-plugin/about.mdxdocs/adaptive-plugin/acg.mdxdocs/adaptive-plugin/adaptive-hints.mdxdocs/adaptive-plugin/configuration.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/getting-started/configuration.mdxdocs/getting-started/installation.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/getting-started/quick-start/python.mdxdocs/index.ymldocs/instrument-applications/about.mdxdocs/instrument-applications/advanced-guide.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/integrate-into-frameworks/about.mdxdocs/integrate-into-frameworks/adding-scopes.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/integrate-into-frameworks/non-serializable-data.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/nemo-relay-cli/about.mdxdocs/observability-plugin/about.mdxdocs/observability-plugin/atif.mdxdocs/observability-plugin/atof.mdxdocs/observability-plugin/configuration.mdxdocs/observability-plugin/openinference.mdxdocs/observability-plugin/opentelemetry.mdxdocs/reference/performance.mdxdocs/resources/support-and-faqs.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/supported-integrations/about.mdxdocs/supported-integrations/deepagents.mdxdocs/supported-integrations/langchain.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/openclaw-plugin.mdxscripts/docs/generate_rust_library_reference.py
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Check / Run
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (20)
{docs/**,README.md,CONTRIBUTING.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
{docs/**,README.md,CONTRIBUTING.md}: For docs-only changes, run targeted checks only if commands, package names, or examples changed. Usejust docsfor docs-site builds andjust docs-linkcheckwhen links changed
Run docs site build withjust docs
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxCONTRIBUTING.mddocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/index.ymldocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
{docs/**,README.md,CONTRIBUTING.md,**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Run docs link validation with
just docs-linkcheckwhen links change
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxCONTRIBUTING.mddocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/index.ymldocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
{docs/**,README.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Verify README and docs entry points still match current package names and paths for large or public-facing changes
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxdocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/index.ymldocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
{docs/**,examples/**,README.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Verify examples still run with documented commands for large or public-facing changes
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxdocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/index.ymldocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
{docs/**,README.md,**/Cargo.toml,**/package.json,**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Ensure renamed public surfaces are reflected consistently in manifests and docs for large or public-facing changes
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxCONTRIBUTING.mddocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/index.ymldocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
**/*.{md,mdx,py,sh,yaml,yml,toml,json}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxscripts/docs/generate_rust_library_reference.pydocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxCONTRIBUTING.mddocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/index.ymldocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
In MDX files, top-of-file comments must use JSX comment delimiters: {/* to open and */} to close. Do not use HTML comments for MDX SPDX headers.
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxdocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
**/*.{html,md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license header in HTML and Markdown files using the format
<!-- SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0 -->
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxCONTRIBUTING.mddocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/supported-integrations/langgraph.mdxdocs/instrument-applications/about.mdxdocs/reference/performance.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/supported-integrations/about.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/langchain.mdxdocs/observability-plugin/about.mdxdocs/integrate-into-frameworks/using-codecs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/adaptive-plugin/about.mdxdocs/integrate-into-frameworks/code-examples.mdxdocs/instrument-applications/advanced-guide.mdxdocs/about-nemo-relay/concepts/framework-integrations.mdxdocs/getting-started/installation.mdxdocs/observability-plugin/openinference.mdxCONTRIBUTING.mddocs/integrate-into-frameworks/adding-scopes.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/supported-integrations/deepagents.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/adaptive-plugin/configuration.mdxdocs/index.ymldocs/nemo-relay-cli/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/support-and-faqs.mdxdocs/integrate-into-frameworks/wrap-llm-calls.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/integrate-into-frameworks/provider-codecs.mdxdocs/integrate-into-frameworks/non-serializable-data.mdx
{pyproject.toml,**/*.py}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Maintain consistency between Python package names in
pyproject.tomland import paths used throughout the codebase
Files:
scripts/docs/generate_rust_library_reference.py
**/*.{py,txt,toml,cfg,yaml,yml}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update Python package names and top-level module imports during coordinated rename operations
Files:
scripts/docs/generate_rust_library_reference.pydocs/index.yml
{scripts/**,third-party/**}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
{scripts/**,third-party/**}: For third-party integration or patch changes, run patch validation with./scripts/apply-patches.sh --checkand relevant integration tests. Keep root./scripts/*.shwrappers for third-party flows
Run third-party patch bootstrap with./scripts/bootstrap-third-party.sh
Run third-party patch validation with./scripts/apply-patches.sh --check
Files:
scripts/docs/generate_rust_library_reference.py
**/*.py
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*.py: Run Python formatting withuv run ruff format python
Run Python testing withuv run pytest -k "<pattern>"
**/*.py: Keep SPDX headers on Python source files. The project is Apache-2.0.
Usesnake_casefor Python binding naming conventions.
Runjust test-pythonfor Python binding or wrapper changes.Use Ruff with rule sets
E,F,W,Ifor Python lintingUse Ruff formatter with line length 120 and double quotes for Python code formatting
Use
tyfor Python type checkingUse Python
snake_casenaming convention for Python identifiersInclude SPDX license header in all Python source files using the format
# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0
Files:
scripts/docs/generate_rust_library_reference.py
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}
⚙️ CodeRabbit configuration file
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}: Review automation changes for reproducibility, pinned versions where appropriate, secret handling, and consistency with the documented validation matrix.
Pay attention to commands that need generated native artifacts, FFI libraries, or platform-specific environment variables.
Files:
scripts/docs/generate_rust_library_reference.py
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
CONTRIBUTING.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
CONTRIBUTING.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Documentation must be updated if activation or usage changed
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links ...
Files:
CONTRIBUTING.md
**/{docs,examples,**/*.md,*.patch,*.diff,.github,*.sh,*.yaml,*.yml}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, CI configuration, and patch artifacts when performing rename operations
Files:
CONTRIBUTING.mddocs/index.yml
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
CONTRIBUTING.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as "here" or "read more."
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
CONTRIBUTING.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Use branch name prefixes: `feat/` for new features, `fix/` for bug fixes, `docs/` for documentation-only changes, `test/` for test additions or modifications, and `refactor/` for code restructuring without behavior changes
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Use raw Rust-compatible SemVer without leading `v` for versioned release tags (e.g., `0.1.0`, `0.1.0-rc.1`, not `v0.1.0`)
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Every commit in a pull request must include a Developer Certificate of Origin sign-off using `git commit -s` or by adding a `Signed-off-by:` trailer
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Use commit message format `type: short description` with valid types: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`, `perf`, keeping the first line under 72 characters
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: All PRs require at least one approving review before merge, and CI must pass before merging
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Scrutinize any `SONAR_IGNORE_START` / `SONAR_IGNORE_END` markers and require reviewer sign-off plus written justification before approving
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Use `SONAR_IGNORE_START` / `SONAR_IGNORE_END` suppressions only for documented false positives that cannot be resolved in code or analyzer configuration, keep the ignored block as small as possible, add a brief comment explaining the suppression, and call it out in the PR description
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Run all pre-commit hooks before submitting a pull request using `uv run pre-commit run --all-files`
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Run tests for every language affected by changes; if changes touch the core Rust crate, run tests across all bindings since they depend on it
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Update documentation when changes affect public behavior, bindings, examples, or workspace structure, including `README.md`, relevant reference docs, crate/package READMEs, embedded documentation snippets, and binding-support notes
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-27T02:20:40.560Z
Learning: Run `just docs` (or `./scripts/build-docs.sh html`) to regenerate Fern API reference pages before validation for documentation-heavy changes
🪛 LanguageTool
docs/integrate-into-frameworks/using-codecs.mdx
[style] ~177-~177: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ized request or response annotations. - Use [Handle Non-Serializable Data](/integra...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~178-~178: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ts cannot pass through JSON payloads. - Use [Integrate into Frameworks Code Example...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/integrate-into-frameworks/provider-response-codecs.mdx
[style] ~349-~349: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s and full request/response examples. - Use [Wrap LLM Calls](/integrate-into-framew...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~350-~350: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o add the managed LLM boundary first. - Use [Observability](/observability-plugin/a...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (40)
docs/index.yml (1)
5-5: LGTM!Also applies to: 17-17, 25-25, 29-29, 33-33
CONTRIBUTING.md (1)
328-330: LGTM!docs/about-nemo-relay/overview.mdx (1)
70-71: LGTM!Also applies to: 74-74, 76-76
docs/about-nemo-relay/concepts/framework-integrations.mdx (1)
154-154: LGTM!docs/about-nemo-relay/concepts/plugins.mdx (1)
153-155: LGTM!Also applies to: 166-166
docs/about-nemo-relay/concepts/subscribers.mdx (1)
137-137: LGTM!Also applies to: 143-143, 158-160
docs/about-nemo-relay/ecosystem.mdx (1)
114-117: LGTM!docs/getting-started/installation.mdx (1)
79-80: LGTM!Also applies to: 93-94
docs/getting-started/configuration.mdx (1)
46-47: LGTM!Also applies to: 61-61
docs/getting-started/agent-runtime-primer.mdx (1)
103-103: LGTM!Also applies to: 108-108, 110-110
docs/getting-started/quick-start/nodejs.mdx (1)
122-122: LGTM!docs/getting-started/quick-start/python.mdx (1)
11-11: LGTM!Also applies to: 126-126
scripts/docs/generate_rust_library_reference.py (1)
165-169: LGTM!docs/adaptive-plugin/about.mdx (1)
44-44: LGTM!Also applies to: 48-53, 56-57
docs/adaptive-plugin/configuration.mdx (1)
37-38: LGTM!docs/build-plugins/plugin-configuration-files.mdx (1)
267-270: LGTM!docs/observability-plugin/about.mdx (1)
57-60: LGTM!Also applies to: 85-90
docs/observability-plugin/openinference.mdx (1)
53-53: LGTM!docs/supported-integrations/about.mdx (1)
32-40: LGTM!Also applies to: 44-44
docs/supported-integrations/deepagents.mdx (1)
108-108: LGTM!docs/supported-integrations/langchain.mdx (1)
93-93: LGTM!docs/supported-integrations/langgraph.mdx (1)
106-106: LGTM!docs/supported-integrations/openclaw-plugin.mdx (1)
204-205: LGTM!docs/instrument-applications/about.mdx (1)
27-27: LGTM!docs/instrument-applications/advanced-guide.mdx (1)
226-226: LGTM!docs/instrument-applications/instrument-llm-call.mdx (1)
244-245: LGTM!docs/instrument-applications/instrument-tool-call.mdx (1)
32-32: LGTM!Also applies to: 222-222
docs/integrate-into-frameworks/about.mdx (1)
36-36: LGTM!Also applies to: 42-49
docs/integrate-into-frameworks/code-examples.mdx (1)
12-18: LGTM!Also applies to: 259-259
docs/integrate-into-frameworks/adding-scopes.mdx (1)
183-184: LGTM!docs/integrate-into-frameworks/non-serializable-data.mdx (1)
188-190: LGTM!docs/integrate-into-frameworks/provider-codecs.mdx (1)
36-36: LGTM!Also applies to: 48-48, 371-372, 374-374
docs/integrate-into-frameworks/provider-response-codecs.mdx (1)
27-27: LGTM!Also applies to: 348-350
docs/integrate-into-frameworks/using-codecs.mdx (1)
21-21: LGTM!Also applies to: 43-43, 176-178
docs/integrate-into-frameworks/wrap-llm-calls.mdx (1)
20-20: LGTM!Also applies to: 35-35, 157-159
docs/integrate-into-frameworks/wrap-tool-calls.mdx (1)
20-20: LGTM!Also applies to: 127-127, 152-154
docs/reference/performance.mdx (1)
37-37: LGTM!docs/resources/support-and-faqs.mdx (1)
205-205: LGTM!Also applies to: 225-225, 304-304, 314-314, 328-341, 387-390, 406-406, 427-429, 438-438, 444-446
docs/resources/troubleshooting/trace-incident-runbook.mdx (1)
68-68: LGTM!Also applies to: 108-109, 125-126, 153-156
docs/nemo-relay-cli/about.mdx (1)
34-34: LGTM!
Signed-off-by: Will Killian <wkillian@nvidia.com>
willkill07
force-pushed
the
docs/fix-broken-doc-links
branch
from
ec47cd2 to
89ce6a6
Compare
1 participant
Overview
Align the docs source tree with the published Fern slugs and update internal links that were producing broken documentation routes.
Details
Validation:
missing=0just docspasses with zero errors. Fern still warns about old generated Rust API underscore URLs because this change intentionally does not add redirects.Where should the reviewer start?
Start with
docs/index.ymlfor the navigation/source-path alignment, then reviewscripts/docs/generate_rust_library_reference.pyfor the generated Rust reference path change.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit